Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
remark-lint-checkbox-character-style
Advanced tools
remark-lint rule to warn when list item checkboxes violate a given style
Warn when list item checkboxes violate a given style.
Options: Object
or 'consistent'
, default: 'consistent'
.
'consistent'
detects the first used checked and unchecked checkbox
styles and warns when subsequent checkboxes use different styles.
Styles can also be passed in like so:
{checked: 'x', unchecked: ' '}
remark-stringify
formats checked checkboxes using x
(lowercase X) and unchecked checkboxes
as ·
(a single space).
See Using remark to fix your Markdown on how to automatically fix warnings for this rule.
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-consistent | 'consistent' |
ok.md
When configured with { checked: 'x' }
.
- [x] List item
- [x] List item
No messages.
ok.md
When configured with { checked: 'X' }
.
- [X] List item
- [X] List item
No messages.
ok.md
When configured with { unchecked: ' ' }
.
Note: ·
represents a space.
- [ ] List item
- [ ] List item
- [ ]··
- [ ]
No messages.
ok.md
When configured with { unchecked: '\t' }
.
Note: »
represents a tab.
- [»] List item
- [»] List item
No messages.
not-ok.md
Note: »
represents a tab.
- [x] List item
- [X] List item
- [ ] List item
- [»] List item
2:4-2:5: Checked checkboxes should use `x` as a marker
4:4-4:5: Unchecked checkboxes should use ` ` as a marker
not-ok.md
When configured with { unchecked: '💩' }
.
1:1: Incorrect unchecked checkbox marker `💩`: use either `'\t'`, or `' '`
not-ok.md
When configured with { checked: '💩' }
.
1:1: Incorrect checked checkbox marker `💩`: use either `'x'`, or `'X'`
npm:
npm install remark-lint-checkbox-character-style
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-checkbox-character-style",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-checkbox-character-style readme.md
Or use this on the API:
var remark = require('remark')
var report = require('vfile-reporter')
remark()
.use(require('remark-lint'))
+ .use(require('remark-lint-checkbox-character-style'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file))
})
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
remark-lint rule to warn when list item checkboxes violate a given style
The npm package remark-lint-checkbox-character-style receives a total of 64,662 weekly downloads. As such, remark-lint-checkbox-character-style popularity was classified as popular.
We found that remark-lint-checkbox-character-style demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.